

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The loggable module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The logging module" href="mod_pyamp_logging.html" />
    <link rel="next" title="The meta module" href="pyamp_logging_meta.html" />
    <link rel="prev" title="The prefix module" href="pyamp_logging_prefix.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_logging_meta.html" title="The meta module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_logging_prefix.html" title="The prefix module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_logging.html" accesskey="U">The logging module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.logging.loggable">
<span id="the-loggable-module"></span><h1>The loggable module<a class="headerlink" href="#module-pyamp.logging.loggable" title="Permalink to this headline">¶</a></h1>
<p>The loggable module contains the Loggable class which provides the ability
to create a class which is loggable. Any class that is Loggable will have the
following logging functions exposed:</p>
<blockquote>
<ul class="simple">
<li>debug(message, debugLevel, args, kwargs)</li>
<li>info(message, debugLevel, args, kwargs)</li>
<li>warn(message, debugLevel, args, kwargs)</li>
<li>warning(message, debugLevel, args, kwargs)</li>
<li>error(message, debugLevel, args, kwargs)</li>
<li>fatal(message, debugLevel, args, kwargs)</li>
<li>critical(message, debugLevel, args, kwargs)</li>
<li>log(logLevel, message, debugLevel, args, kwargs)</li>
</ul>
</blockquote>
<div class="section" id="the-logdata-class">
<h2>The LogData class<a class="headerlink" href="#the-logdata-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-8e4283231783ec30e92e8894844144b3e91619ee.png" alt="Inheritance diagram of pyamp.logging.loggable.LogData" usemap="#inheritanceac019503d9" class="inheritance"/>
<map id="inheritanceac019503d9" name="inheritanceac019503d9">
<area shape="rect" href="pyamp_logging_logger.html#pyamp.logging.logger.LogData" title="pyamp.logging.logger.LogData" alt="" coords="5,7,221,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.logging.loggable.LogData">
<em class="property">class </em><tt class="descclassname">pyamp.logging.loggable.</tt><tt class="descname">LogData</tt><big>(</big><em>logLevel=20</em>, <em>debugLevel=0</em>, <em>prefix=&lt;pyamp.logging.prefix.Prefix instance at 0x957a32c&gt;</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.LogData" title="Permalink to this definition">¶</a></dt>
<dd><p>The LogData class provides the ability to store logging data for an
entire system in an object that can be easily handled.</p>
<p>The LogData class stores a <tt class="xref py py-class docutils literal"><span class="pre">LogLevel</span></tt> and an integer debug level
for a system, and provides the ability to create a named <a class="reference internal" href="#pyamp.logging.loggable.Logger" title="pyamp.logging.loggable.Logger"><tt class="xref py py-class docutils literal"><span class="pre">Logger</span></tt></a>
from the stored values.</p>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Any Logger objects created from this LogData object will have a</span>
<span class="c"># LogLevel of DEBUG, and a debug level of 10.</span>
<span class="n">logData</span> <span class="o">=</span> <span class="n">LogData</span><span class="p">(</span><span class="n">LogLevel</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>

<span class="c"># Create a logger named &#39;ExampleLogger&#39; which will log messages</span>
<span class="c"># with a red foreground color.</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logData</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;ExampleLogger&quot;</span><span class="p">,</span> <span class="n">Colors</span><span class="o">.</span><span class="n">Foreground</span><span class="o">.</span><span class="n">Red</span><span class="p">)</span>

<span class="c"># This message will be displayed</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Example message&quot;</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>

<span class="c"># This message will not be displayed</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Example message&quot;</span><span class="p">,</span> <span class="mi">11</span><span class="p">)</span>
</pre></div>
</div>
<p>LogData objects can be easily passed around which allows the
:class::<cite>LogLevel</cite> and debug level values to be easily propagated
throughout the system, rather than having individual values for each
system component.</p>
<ul class="simple">
<li>logLevel &#8211; The log level</li>
<li>debugLevel &#8211; The debug level</li>
<li>prefix &#8211; The prefix chain to use for all loggers</li>
</ul>
<dl class="method">
<dt id="pyamp.logging.loggable.LogData.get">
<tt class="descname">get</tt><big>(</big><em>name=None</em>, <em>color=0</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.LogData.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a new Logger with the given name.</p>
<ul class="simple">
<li>name &#8211; The name to assign the Logger</li>
<li>color &#8211; The color to use for the Logger</li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-colors-class">
<h2>The Colors class<a class="headerlink" href="#the-colors-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-82f55381454881b29cfde919437d2edf606aa32d.png" alt="Inheritance diagram of pyamp.logging.loggable.Colors" usemap="#inheritancec8c72ff4e4" class="inheritance"/>
<map id="inheritancec8c72ff4e4" name="inheritancec8c72ff4e4">
<area shape="rect" href="pyamp_logging_colors.html#pyamp.logging.colors.Colors" title="pyamp.logging.colors.Colors" alt="" coords="5,7,205,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.logging.loggable.Colors">
<em class="property">class </em><tt class="descclassname">pyamp.logging.loggable.</tt><tt class="descname">Colors</tt><a class="headerlink" href="#pyamp.logging.loggable.Colors" title="Permalink to this definition">¶</a></dt>
<dd><p>The Colors class contains two classes which define possible Foreground
and Background colors. These colors can be used to colorize console output
in a specific way.</p>
<dl class="class">
<dt id="pyamp.logging.loggable.Colors.Background">
<em class="property">class </em><tt class="descname">Background</tt><a class="headerlink" href="#pyamp.logging.loggable.Colors.Background" title="Permalink to this definition">¶</a></dt>
<dd><p>The Background class contains definitions of the following
background colors.</p>
<ul class="simple">
<li><em>White_Bold_Underline</em></li>
<li><em>Blue</em>, and <em>Light_Blue</em></li>
<li><em>Purple</em>, and <em>Light_Purple</em></li>
<li><em>Green</em>, and <em>Light_Green</em></li>
<li><em>Red</em>, and <em>Light_Red</em></li>
<li><em>Gray</em>, and <em>Light_Gray</em></li>
<li><em>Cyan</em>, and <em>Light_Cyan</em></li>
<li><em>Orange</em>, and <em>Light_Yellow</em></li>
</ul>
</dd></dl>

<dl class="class">
<dt id="pyamp.logging.loggable.Colors.Foreground">
<em class="property">class </em><tt class="descclassname">Colors.</tt><tt class="descname">Foreground</tt><a class="headerlink" href="#pyamp.logging.loggable.Colors.Foreground" title="Permalink to this definition">¶</a></dt>
<dd><p>The Foreground class contains definitions of the following
foreground colors.</p>
<ul class="simple">
<li><em>White</em></li>
<li><em>White_Bold</em></li>
<li><em>White_Underline</em></li>
<li><em>Black</em></li>
<li><em>Blue</em>, and <em>Light_Blue</em></li>
<li><em>Purple</em>, and <em>Light_Purple</em></li>
<li><em>Green</em>, and <em>Light_Green</em></li>
<li><em>Red</em>, and <em>Light_Red</em></li>
<li><em>Gray</em>, and <em>Light_Gray</em></li>
<li><em>Cyan</em>, and <em>Light_Cyan</em></li>
<li><em>Orange</em>, and <em>Light_Yellow</em></li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-logger-class">
<h2>The Logger class<a class="headerlink" href="#the-logger-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-d28302d33a23c70d127bb9f56a95e7d38005b1de.png" alt="Inheritance diagram of pyamp.logging.loggable.Logger" usemap="#inheritance7bf1b0d103" class="inheritance"/>
<map id="inheritance7bf1b0d103" name="inheritance7bf1b0d103">
<area shape="rect" href="pyamp_logging_logger.html#pyamp.logging.logger.Logger" title="pyamp.logging.logger.Logger" alt="" coords="5,161,211,188"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.logging.loggable.Logger">
<em class="property">class </em><tt class="descclassname">pyamp.logging.loggable.</tt><tt class="descname">Logger</tt><big>(</big><em>name=None</em>, <em>color=0</em>, <em>prefix=&lt;pyamp.logging.prefix.Prefix instance at 0x957d32c&gt;</em>, <em>logLevel=30</em>, <em>debugLevel=0</em>, <em>handler=&lt;logging.StreamHandler instance at 0x957af2c&gt;</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger" title="Permalink to this definition">¶</a></dt>
<dd><p>The Logger class provides the ability to log various types
of messages to a specific stream, and formats the messages using given
<tt class="xref py py-class docutils literal"><span class="pre">Prefix</span></tt> objects.</p>
<p>The Logger class will log each <tt class="xref py py-class docutils literal"><span class="pre">LogLevel</span></tt> with a colored
prefix indicating the name of the log level. Logged messages are only
displayed in the event that the <tt class="xref py py-class docutils literal"><span class="pre">LogLevel</span></tt> at which they are
logged is greater than or equal to the current <tt class="xref py py-class docutils literal"><span class="pre">LogLevel</span></tt> of the
Logger which is logging the message. Each <tt class="xref py py-class docutils literal"><span class="pre">LogLevel.DEBUG</span></tt>
message can also have an optional debug level specified, which will allow
that message to be displayed so long as the specified debug level is less
than or equal to the configured debug level of the Logger object.</p>
<p>Each Logger object can be named, and colored, which means that
any message logged using that object will be displayed with a prefix
indicating the name (and displayed in the specified color) of the object
which logged the message.</p>
<p>Logger objects can be given a chain of <tt class="xref py py-class docutils literal"><span class="pre">Prefix</span></tt> objects.
Any message logged using that Logger object will then have a
series of prefixes added to the front of the message.</p>
<p>Logger objects can also have a handler specified, which specifies
the type of stream which will be handled by this Logger. For
example, to output to the console a value of <a class="reference external" href="http://docs.python.org/library/logging.handlers.html#logging.StreamHandler" title="(in Python v2.7)"><tt class="docutils literal"><span class="pre">logging.StreamHandler</span></tt></a>
could be specified, whereas a value of <a class="reference external" href="http://docs.python.org/library/logging.handlers.html#logging.FileHandler" title="(in Python v2.7)"><tt class="docutils literal"><span class="pre">logging.FileHandler</span></tt></a> could
be specified to log to a specific file.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Create a Logger with the name &#39;Example1&#39;</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">Logger</span><span class="p">(</span><span class="s">&quot;Example1&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Information message&quot;</span><span class="p">)</span>

<span class="c"># Create a Logger with the name &#39;Example2&#39;, a foreground</span>
<span class="c"># color of Blue, and logs DEBUG messages that have a debug</span>
<span class="c"># level less than or equal to 10.</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">Logger</span><span class="p">(</span><span class="s">&quot;Example2&quot;</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="n">Colors</span><span class="o">.</span><span class="n">Foreground</span><span class="o">.</span><span class="n">Blue</span><span class="p">,</span>
                <span class="n">logLevel</span><span class="o">=</span><span class="n">LogLevel</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">debugLevel</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;This message is displayed&quot;</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;This message is not displayed&quot;</span><span class="p">,</span> <span class="mi">11</span><span class="p">)</span>

<span class="c"># Create a Logger with the name &#39;Example3&#39; that only displays</span>
<span class="c"># ERROR messages</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">Logger</span><span class="p">(</span><span class="s">&quot;Example3&quot;</span><span class="p">,</span> <span class="n">logLevel</span><span class="o">=</span><span class="n">LogLevel</span><span class="o">.</span><span class="n">ERROR</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s">&quot;This would not be displayed&quot;</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li>name &#8211; The name of the Logger</li>
<li>color &#8211; The color to use for this Logger</li>
<li>prefix &#8211; The <tt class="xref py py-class docutils literal"><span class="pre">Prefix</span></tt> chain to use for this Logger</li>
<li>logLevel &#8211; The log level to use for this Logger</li>
<li>debugLevel &#8211; The debug level</li>
<li>handler &#8211; The handler to use for this Logger</li>
</ul>
<dl class="method">
<dt id="pyamp.logging.loggable.Logger.critical">
<tt class="descname">critical</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.critical" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a critical message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.debug">
<tt class="descname">debug</tt><big>(</big><em>message</em>, <em>level=0</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.debug" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a debug message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>level &#8211; The debug level</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.error">
<tt class="descname">error</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.error" title="Permalink to this definition">¶</a></dt>
<dd><p>Log an error message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.fatal">
<tt class="descname">fatal</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.fatal" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a fatal message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.info">
<tt class="descname">info</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.info" title="Permalink to this definition">¶</a></dt>
<dd><p>Log an info message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.log">
<tt class="descname">log</tt><big>(</big><em>logLevel</em>, <em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.log" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a message at the given log level.</p>
<ul class="simple">
<li>logLevel &#8211; The level at which to log</li>
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.setName">
<tt class="descname">setName</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.setName" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the name for this logger.</p>
<ul class="simple">
<li>name &#8211; The name</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.setPrefix">
<tt class="descname">setPrefix</tt><big>(</big><em>prefix</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.setPrefix" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the prefix for this logger.</p>
<ul class="simple">
<li>prefix &#8211; The prefix</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.warn">
<tt class="descname">warn</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.warn" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a warning message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Logger.warning">
<tt class="descname">warning</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyamp.logging.loggable.Logger.warning" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a warning message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-loggable-class">
<h2>The Loggable class<a class="headerlink" href="#the-loggable-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-83c6a3755fd037af0a91e4e37ff42a424a3857eb.png" alt="Inheritance diagram of pyamp.logging.loggable.Loggable" usemap="#inheritance76cb6aa059" class="inheritance"/>
<map id="inheritance76cb6aa059" name="inheritance76cb6aa059">
<area shape="rect" href="#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="5,7,240,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.logging.loggable.Loggable">
<em class="property">class </em><tt class="descclassname">pyamp.logging.loggable.</tt><tt class="descname">Loggable</tt><big>(</big><em>name=None</em>, <em>logger=None</em>, <em>color=0</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable" title="Permalink to this definition">¶</a></dt>
<dd><p>The Loggable class provides the ability to expose the logging methods
(i.e., debug, info, warn, warning, error, fatal, critical, and error) on
a specific class. This provides the ability to easily log messages
throughout a class without needed to specifically create a <a class="reference internal" href="#pyamp.logging.loggable.Logger" title="pyamp.logging.loggable.Logger"><tt class="xref py py-class docutils literal"><span class="pre">Logger</span></tt></a>
object.</p>
<p>The Loggable class can be created from either a <a class="reference internal" href="#pyamp.logging.loggable.Logger" title="pyamp.logging.loggable.Logger"><tt class="xref py py-class docutils literal"><span class="pre">Logger</span></tt></a> object, or
a <a class="reference internal" href="#pyamp.logging.loggable.LogData" title="pyamp.logging.loggable.LogData"><tt class="xref py py-class docutils literal"><span class="pre">LogData</span></tt></a> object.</p>
<ul class="simple">
<li>name &#8211; The name of the Logger</li>
<li>logger &#8211; The LogData, or Logger object to use</li>
<li>color &#8211; The color of the Logger</li>
</ul>
<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.critical">
<tt class="descname">critical</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.critical"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.critical" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a critical message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.debug">
<tt class="descname">debug</tt><big>(</big><em>message</em>, <em>level=0</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.debug" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a debug message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>level &#8211; The debug level</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.error">
<tt class="descname">error</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.error" title="Permalink to this definition">¶</a></dt>
<dd><p>Log an error message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.fatal">
<tt class="descname">fatal</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.fatal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.fatal" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a fatal message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.info">
<tt class="descname">info</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.info" title="Permalink to this definition">¶</a></dt>
<dd><p>Log an info message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.log">
<tt class="descname">log</tt><big>(</big><em>logLevel</em>, <em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.log" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a message at the given log level.</p>
<ul class="simple">
<li>logLevel &#8211; The level at which to log</li>
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.warn">
<tt class="descname">warn</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.warn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.warn" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a warning message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.logging.loggable.Loggable.warning">
<tt class="descname">warning</tt><big>(</big><em>message</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/pyamp/logging/loggable.html#Loggable.warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.logging.loggable.Loggable.warning" title="Permalink to this definition">¶</a></dt>
<dd><p>Log a warning message.</p>
<ul class="simple">
<li>message &#8211; The message to log</li>
<li>args &#8211; The arguments</li>
<li>kwargs &#8211; The keyword arguments</li>
</ul>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The loggable module</a><ul>
<li><a class="reference internal" href="#the-logdata-class">The LogData class</a></li>
<li><a class="reference internal" href="#the-colors-class">The Colors class</a></li>
<li><a class="reference internal" href="#the-logger-class">The Logger class</a></li>
<li><a class="reference internal" href="#the-loggable-class">The Loggable class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_logging_prefix.html"
                        title="previous chapter">The prefix module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pyamp_logging_meta.html"
                        title="next chapter">The meta module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_logging_loggable.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_logging_meta.html" title="The meta module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_logging_prefix.html" title="The prefix module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_logging.html" >The logging module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>